/***************************************************************************
 * Copyright 2012-2013 TXT e-solutions SpA
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * This work was performed within the IoT_at_Work Project
 * and partially funded by the European Commission's
 * 7th Framework Programme under the contract ICT-257367.
 *
 * Authors:
 *      Salvatore Piccione (TXT e-solutions SpA)
 *
 * Contributors:
 *        Domenico Rotondi (TXT e-solutions SpA)
 **************************************************************************/
package it.txt.ens.core.factory;

import it.txt.ens.core.KeystoreParameters;

import java.io.File;

/**
 * @author Salvatore Piccione (TXT e-solutions SpA - salvatore.piccione AT txtgroup.com)
 * @author Domenico Rotondi (TXT e-solutions SpA - domenico.rotondi AT txtgroup.com)
 *
 */
public interface KeystoreParametersFactory {
    
    static final String PREFIX = "ens.keystore.";
    /**
     * Name of the configuration parameter indicating the keystore path in the file system.
     */
    public static final String KEYSTORE_PATH = PREFIX + "path";
    /**
     * Name of the configuration parameter indicating the keystore password.
     */
    public static final String KEYSTORE_PASSWORD = PREFIX + "pwd";
    static final int NUMBER_OF_MANDATORY_FIELDS = 2;
    
    /**
     * Creates a new {@link KeystoreParameters} object.
     * @param keystore the keystore file
     * @param password the keystore passeword
     * @return a new {@link KeystoreParameters} object.
     * @throws IllegalArgumentException if at least one parameter is <code>null</code> or if <code>password</code> is emtpy
     */
    public KeystoreParameters create (File keystore, char[] password) throws IllegalArgumentException;
}
